home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / man.n / grab.n < prev    next >
Encoding:
Text File  |  1995-07-21  |  9.7 KB  |  323 lines
  1. '\"
  2. '\" Copyright (c) 1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/grab.n,v 1.7 93/04/01 09:52:41 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .\" The definitions below are for supplemental macros used in Tcl/Tk
  24. .\" manual entries.
  25. .\"
  26. .\" .HS name section [date [version]]
  27. .\"    Replacement for .TH in other man pages.  See below for valid
  28. .\"    section names.
  29. .\"
  30. .\" .AP type name in/out [indent]
  31. .\"    Start paragraph describing an argument to a library procedure.
  32. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  33. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  34. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  35. .\"    needed;  use .AS below instead)
  36. .\"
  37. .\" .AS [type [name]]
  38. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  39. .\"    name are examples of largest possible arguments that will be passed
  40. .\"    to .AP later.  If args are omitted, default tab stops are used.
  41. .\"
  42. .\" .BS
  43. .\"    Start box enclosure.  From here until next .BE, everything will be
  44. .\"    enclosed in one large box.
  45. .\"
  46. .\" .BE
  47. .\"    End of box enclosure.
  48. .\"
  49. .\" .VS
  50. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  51. .\"    of man pages.
  52. .\"
  53. .\" .VE
  54. .\"    End of vertical sidebar.
  55. .\"
  56. .\" .DS
  57. .\"    Begin an indented unfilled display.
  58. .\"
  59. .\" .DE
  60. .\"    End of indented unfilled display.
  61. .\"
  62. '\"    # Heading for Tcl/Tk man pages
  63. .de HS
  64. .ds ^3 \\0
  65. .if !"\\$3"" .ds ^3 \\$3
  66. .if '\\$2'cmds'       .TH \\$1 1 \\*(^3 \\$4
  67. .if '\\$2'lib'        .TH \\$1 3 \\*(^3 \\$4
  68. .if '\\$2'tcl'        .TH \\$1 n \\*(^3 Tcl "Tcl Built-In Commands"
  69. .if '\\$2'tk'         .TH \\$1 n \\*(^3 Tk "Tk Commands"
  70. .if '\\$2'tclc'        .TH \\$1 3 \\*(^3 Tcl "Tcl Library Procedures"
  71. .if '\\$2'tkc'         .TH \\$1 3 \\*(^3 Tk "Tk Library Procedures"
  72. .if '\\$2'tclcmds'         .TH \\$1 1 \\*(^3 Tk "Tcl Applications"
  73. .if '\\$2'tkcmds'         .TH \\$1 1 \\*(^3 Tk "Tk Applications"
  74. .if t .wh -1.3i ^B
  75. .nr ^l \\n(.l
  76. .ad b
  77. ..
  78. '\"    # Start an argument description
  79. .de AP
  80. .ie !"\\$4"" .TP \\$4
  81. .el \{\
  82. .   ie !"\\$2"" .TP \\n()Cu
  83. .   el          .TP 15
  84. .\}
  85. .ie !"\\$3"" \{\
  86. .ta \\n()Au \\n()Bu
  87. \&\\$1    \\fI\\$2\\fP    (\\$3)
  88. .\".b
  89. .\}
  90. .el \{\
  91. .br
  92. .ie !"\\$2"" \{\
  93. \&\\$1    \\fI\\$2\\fP
  94. .\}
  95. .el \{\
  96. \&\\fI\\$1\\fP
  97. .\}
  98. .\}
  99. ..
  100. '\"    # define tabbing values for .AP
  101. .de AS
  102. .nr )A 10n
  103. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  104. .nr )B \\n()Au+15n
  105. .\"
  106. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  107. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  108. ..
  109. '\"    # BS - start boxed text
  110. '\"    # ^y = starting y location
  111. '\"    # ^b = 1
  112. .de BS
  113. .br
  114. .mk ^y
  115. .nr ^b 1u
  116. .if n .nf
  117. .if n .ti 0
  118. .if n \l'\\n(.lu\(ul'
  119. .if n .fi
  120. ..
  121. '\"    # BE - end boxed text (draw box now)
  122. .de BE
  123. .nf
  124. .ti 0
  125. .mk ^t
  126. .ie n \l'\\n(^lu\(ul'
  127. .el \{\
  128. .\"    Draw four-sided box normally, but don't draw top of
  129. .\"    box if the box started on an earlier page.
  130. .ie !\\n(^b-1 \{\
  131. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  132. .\}
  133. .el \}\
  134. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  135. .\}
  136. .\}
  137. .fi
  138. .br
  139. .nr ^b 0
  140. ..
  141. '\"    # VS - start vertical sidebar
  142. '\"    # ^Y = starting y location
  143. '\"    # ^v = 1 (for troff;  for nroff this doesn't matter)
  144. .de VS
  145. .mk ^Y
  146. .ie n 'mc \s12\(br\s0
  147. .el .nr ^v 1u
  148. ..
  149. '\"    # VE - end of vertical sidebar
  150. .de VE
  151. .ie n 'mc
  152. .el \{\
  153. .ev 2
  154. .nf
  155. .ti 0
  156. .mk ^t
  157. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  158. .sp -1
  159. .fi
  160. .ev
  161. .\}
  162. .nr ^v 0
  163. ..
  164. '\"    # Special macro to handle page bottom:  finish off current
  165. '\"    # box/sidebar if in box/sidebar mode, then invoked standard
  166. '\"    # page bottom macro.
  167. .de ^B
  168. .ev 2
  169. 'ti 0
  170. 'nf
  171. .mk ^t
  172. .if \\n(^b \{\
  173. .\"    Draw three-sided box if this is the box's first page,
  174. .\"    draw two sides but no top otherwise.
  175. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  176. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  177. .\}
  178. .if \\n(^v \{\
  179. .nr ^x \\n(^tu+1v-\\n(^Yu
  180. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  181. .\}
  182. .bp
  183. 'fi
  184. .ev
  185. .if \\n(^b \{\
  186. .mk ^y
  187. .nr ^b 2
  188. .\}
  189. .if \\n(^v \{\
  190. .mk ^Y
  191. .\}
  192. ..
  193. '\"    # DS - begin display
  194. .de DS
  195. .RS
  196. .nf
  197. .sp
  198. ..
  199. '\"    # DE - end display
  200. .de DE
  201. .fi
  202. .RE
  203. .sp .5
  204. ..
  205. .HS grab tk
  206. .BS
  207. '\" Note:  do not modify the .SH NAME line immediately below!
  208. .SH NAME
  209. grab \- Confine pointer and keyboard events to a window sub-tree
  210. .SH SYNOPSIS
  211. \fBgrab \fR?\fB\-global\fR? \fIwindow\fR
  212. .br
  213. .VS
  214. \fBgrab \fIoption \fR?arg arg \fR...?
  215. .VE
  216. .BE
  217.  
  218. .SH DESCRIPTION
  219. .PP
  220. This command implements simple pointer and keyboard grabs for Tk.
  221. Tk's grabs are different than the grabs
  222. described in the Xlib documentation.
  223. When a grab is set for a particular window, Tk restricts all pointer
  224. events to the grab window and its descendants in Tk's window hierarchy.
  225. Whenever the pointer is within the grab window's subtree, the pointer
  226. will behave exactly the same as if there had been no grab at all
  227. and all events will be reported in the normal fashion.
  228. When the pointer is outside \fIwindow\fR's tree, button presses and
  229. releases and
  230. mouse motion events are reported to \fIwindow\fR, and window entry
  231. and window exit events are ignored.
  232. The grab subtree ``owns'' the pointer:
  233. windows outside the grab subtree will be visible on the screen
  234. but they will be insensitive until the grab is released.
  235. The tree of windows underneath the grab window can include top-level
  236. windows, in which case all of those top-level windows
  237. and their descendants will continue to receive mouse events
  238. during the grab.
  239. .PP
  240. Two forms of grabs are possible:  local and global.
  241. A local grab affects only the grabbing application:  events will
  242. be reported to other applications as if the grab had never occurred.
  243. Grabs are local by default.
  244. A global grab locks out all applications on the screen,
  245. so that only the given subtree of the grabbing application will be
  246. sensitive to pointer events (mouse button presses, mouse button releases,
  247. pointer motions, window entries, and window exits).
  248. During global grabs the window manager will not receive pointer
  249. events either.
  250. .PP
  251. During local grabs, keyboard events (key presses and key releases)
  252. are delivered as usual:  the window
  253. manager controls which application receives keyboard events, and
  254. if they are sent to any window in the grabbing application then they are
  255. redirected to the focus window.
  256. During a global grab Tk grabs the keyboard so that all keyboard events
  257. are always sent to the grabbing application.
  258. The \fBfocus\fR command is still used to determine which window in the
  259. application receives the keyboard events.
  260. The keyboard grab is released when the grab is released.
  261. .PP
  262. Grabs apply to particular displays.  If an application has windows
  263. on multiple displays then it can establish a separate grab on each
  264. display.
  265. The grab on a particular display affects only the windows on
  266. that display.
  267. It is possible for different applications on a single display to have
  268. simultaneous local grabs, but only one application can have a global
  269. grab on a given display at once.
  270. .PP
  271. The \fBgrab\fR command can take any of the following forms:
  272. .TP
  273. \fBgrab \fR?\fB\-global\fR? \fIwindow\fR
  274. .VS
  275. Same as \fBgrab set\fR, described below.
  276. .TP
  277. \fBgrab current \fR?\fIwindow\fR?
  278. If \fIwindow\fR is specified, returns the name of the current grab
  279. window in this application for \fIwindow\fR's display, or an empty
  280. string if there is no such window.
  281. If \fIwindow\fR is omitted, the command returns a list whose elements
  282. are all of the windows grabbed by this application for all displays,
  283. or an empty string if the application has no grabs.
  284. .TP
  285. \fBgrab release \fIwindow\fR
  286. Releases the grab on \fIwindow\fR if there is one, otherwise does
  287. nothing.  Returns an empty string.
  288. .TP
  289. \fBgrab set \fR?\fB\-global\fR? \fIwindow\fR
  290. Sets a grab on \fIwindow\fR.  If \fB\-global\fR is specified then the
  291. grab is global, otherwise it is local.
  292. If a grab was already in effect for this application on
  293. \fIwindow\fR's display then it is automatically released.
  294. If there is already a grab on \fIwindow\fR and it has the same
  295. global/local form as the requested grab, then the command
  296. does nothing.  Returns an empty string.
  297. .TP
  298. \fBgrab status \fIwindow\fR
  299. Returns \fBnone\fR if no grab is currently set on \fIwindow\fR,
  300. \fBlocal\fR if a local grab is set on \fIwindow\fR, and
  301. \fBglobal\fR if a global grab is set.
  302. .VE
  303.  
  304. .SH BUGS
  305. .PP
  306. It took an incredibly complex and gross implementation to produce
  307. the simple grab effect described above.
  308. Given the current implementation, it isn't safe for applications
  309. to use the Xlib grab facilities at all except through the Tk grab
  310. procedures.
  311. If applications try to manipulate X's grab mechanisms directly,
  312. things will probably break.
  313. .PP
  314. .VS
  315. If a single process is managing several different Tk applications,
  316. only one of those applications can have a local grab for a given
  317. display at any given time.  If the applications are in different
  318. processes, this restriction doesn't exist.
  319. .VE
  320.  
  321. .SH KEYWORDS
  322. grab, keyboard events, pointer events, window
  323.